<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<TITLE>
PercentEscaper (Soy Complete)
</TITLE>


<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style">

<SCRIPT type="text/javascript">
function windowTitle()
{
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="PercentEscaper (Soy Complete)";
    }
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<BODY BGCOLOR="white" onload="windowTitle();">
<HR>


<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../com/google/template/soy/internal/base/Pair.html" title="class in com.google.template.soy.internal.base"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../com/google/template/soy/internal/base/UnescapeUtils.html" title="class in com.google.template.soy.internal.base"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?com/google/template/soy/internal/base/PercentEscaper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PercentEscaper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->

<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.google.template.soy.internal.base</FONT>
<BR>
Class PercentEscaper</H2>
<PRE>
<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
  <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html" title="class in com.google.template.soy.internal.base">com.google.template.soy.internal.base.UnicodeEscaper</A>
      <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>com.google.template.soy.internal.base.PercentEscaper</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html" title="interface in com.google.template.soy.internal.base">Escaper</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class <B>PercentEscaper</B><DT>extends <A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html" title="class in com.google.template.soy.internal.base">UnicodeEscaper</A></DL>
</PRE>

<P>
A <code>UnicodeEscaper</code> that escapes some set of Java characters using
 the URI percent encoding scheme. The set of safe characters (those which
 remain unescaped) can be specified on construction.

 <p>For details on escaping URIs for use in web pages, see section 2.4 of
 <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>.

 <p>In most cases this class should not need to be used directly. If you
 have no special requirements for escaping your URIs, you should use either
 <A HREF="../../../../../../com/google/template/soy/internal/base/CharEscapers.html#uriEscaper()"><CODE>CharEscapers.uriEscaper()</CODE></A> or
 <A HREF="../../../../../../com/google/template/soy/internal/base/CharEscapers.html#uriEscaper(boolean)"><CODE>CharEscapers.uriEscaper(boolean)</CODE></A>.

 <p>When encoding a String, the following rules apply:
 <ul>
 <li>The alphanumeric characters "a" through "z", "A" through "Z" and "0"
 through "9" remain the same.
 <li>Any additionally specified safe characters remain the same.
 <li>If <code>plusForSpace</code> was specified, the space character " " is
 converted into a plus sign "+".
 <li>All other characters are converted into one or more bytes using UTF-8
     encoding and each byte is then represented by the 3-character string
     "%XY", where "XY" is the two-digit, uppercase, hexadecimal representation
     of the byte value.
 </ul>

 <p>RFC 2396 specifies the set of unreserved characters as "-", "_", ".", "!",
 "~", "*", "'", "(" and ")". It goes on to state:

 <p><i>Unreserved characters can be escaped without changing the semantics
 of the URI, but this should not be done unless the URI is being used
 in a context that does not allow the unescaped character to appear.</i>

 <p>For performance reasons the only currently supported character encoding of
 this class is UTF-8.

 <p><b>Note</b>: This escaper produces uppercase hexadecimal sequences. From
 <a href="http://www.ietf.org/rfc/rfc3986.txt">RFC 3986</a>:<br>
 <i>"URI producers and normalizers should use uppercase hexadecimal digits
 for all percent-encodings."</i>
<P>

<P>
<HR>

<P>
<!-- =========== FIELD SUMMARY =========== -->

<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/internal/base/PercentEscaper.html#SAFECHARS_URLENCODER">SAFECHARS_URLENCODER</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A string of safe characters that mimics the behavior of
 <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URLEncoder.html?is-external=true" title="class or interface in java.net"><CODE>URLEncoder</CODE></A>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/internal/base/PercentEscaper.html#SAFEPATHCHARS_URLENCODER">SAFEPATHCHARS_URLENCODER</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A string of characters that do not need to be encoded when used in URI
 path segments, as specified in RFC 3986.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/internal/base/PercentEscaper.html#SAFEQUERYSTRINGCHARS_URLENCODER">SAFEQUERYSTRINGCHARS_URLENCODER</A></B></CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A string of characters that do not need to be encoded when used in URI
 query strings, as specified in RFC 3986.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->

<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/internal/base/PercentEscaper.html#PercentEscaper(java.lang.String, boolean)">PercentEscaper</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;safeChars,
               boolean&nbsp;plusForSpace)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a URI escaper with the specified safe characters and optional
 handling of the space character.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->

<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;char[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/internal/base/PercentEscaper.html#escape(int)">escape</A></B>(int&nbsp;cp)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Escapes the given Unicode code point in UTF-8.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/internal/base/PercentEscaper.html#escape(java.lang.String)">escape</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;s)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the escaped form of a given literal string.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../../com/google/template/soy/internal/base/PercentEscaper.html#nextEscapeIndex(java.lang.CharSequence, int, int)">nextEscapeIndex</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;csq,
                int&nbsp;index,
                int&nbsp;end)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Scans a sub-sequence of characters from a given <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang"><CODE>CharSequence</CODE></A>,
 returning the index of the next character that requires escaping.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.google.template.soy.internal.base.UnicodeEscaper"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class com.google.template.soy.internal.base.<A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html" title="class in com.google.template.soy.internal.base">UnicodeEscaper</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#codePointAt(java.lang.CharSequence, int, int)">codePointAt</A>, <A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#escape(java.lang.Appendable)">escape</A>, <A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#escapeSlow(java.lang.String, int)">escapeSlow</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="SAFECHARS_URLENCODER"><!-- --></A><H3>
SAFECHARS_URLENCODER</H3>
<PRE>
public static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>SAFECHARS_URLENCODER</B></PRE>
<DL>
<DD>A string of safe characters that mimics the behavior of
 <A HREF="http://java.sun.com/javase/6/docs/api/java/net/URLEncoder.html?is-external=true" title="class or interface in java.net"><CODE>URLEncoder</CODE></A>.

 TODO: Fix escapers to be compliant with RFC 3986
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.google.template.soy.internal.base.PercentEscaper.SAFECHARS_URLENCODER">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SAFEPATHCHARS_URLENCODER"><!-- --></A><H3>
SAFEPATHCHARS_URLENCODER</H3>
<PRE>
public static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>SAFEPATHCHARS_URLENCODER</B></PRE>
<DL>
<DD>A string of characters that do not need to be encoded when used in URI
 path segments, as specified in RFC 3986. Note that some of these
 characters do need to be escaped when used in other parts of the URI.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.google.template.soy.internal.base.PercentEscaper.SAFEPATHCHARS_URLENCODER">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="SAFEQUERYSTRINGCHARS_URLENCODER"><!-- --></A><H3>
SAFEQUERYSTRINGCHARS_URLENCODER</H3>
<PRE>
public static final <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>SAFEQUERYSTRINGCHARS_URLENCODER</B></PRE>
<DL>
<DD>A string of characters that do not need to be encoded when used in URI
 query strings, as specified in RFC 3986. Note that some of these
 characters do need to be escaped when used in other parts of the URI.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../../../constant-values.html#com.google.template.soy.internal.base.PercentEscaper.SAFEQUERYSTRINGCHARS_URLENCODER">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="PercentEscaper(java.lang.String, boolean)"><!-- --></A><H3>
PercentEscaper</H3>
<PRE>
public <B>PercentEscaper</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;safeChars,
                      boolean&nbsp;plusForSpace)</PRE>
<DL>
<DD>Constructs a URI escaper with the specified safe characters and optional
 handling of the space character.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>safeChars</CODE> - a non null string specifying additional safe characters
        for this escaper (the ranges 0..9, a..z and A..Z are always safe and
        should not be specified here)<DD><CODE>plusForSpace</CODE> - true if ASCII space should be escaped to <code>+</code>
        rather than <code>%20</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if any of the parameters were invalid</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="nextEscapeIndex(java.lang.CharSequence, int, int)"><!-- --></A><H3>
nextEscapeIndex</H3>
<PRE>
protected int <B>nextEscapeIndex</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang">CharSequence</A>&nbsp;csq,
                              int&nbsp;index,
                              int&nbsp;end)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#nextEscapeIndex(java.lang.CharSequence, int, int)">UnicodeEscaper</A></CODE></B></DD>
<DD>Scans a sub-sequence of characters from a given <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true" title="class or interface in java.lang"><CODE>CharSequence</CODE></A>,
 returning the index of the next character that requires escaping.

 <p><b>Note:</b> When implementing an escaper, it is a good idea to override
 this method for efficiency. The base class implementation determines
 successive Unicode code points and invokes <A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#escape(int)"><CODE>UnicodeEscaper.escape(int)</CODE></A> for each of
 them. If the semantics of your escaper are such that code points in the
 supplementary range are either all escaped or all unescaped, this method
 can be implemented more efficiently using <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/CharSequence.html?is-external=true#charAt(int)" title="class or interface in java.lang"><CODE>CharSequence.charAt(int)</CODE></A>.

 <p>Note however that if your escaper does not escape characters in the
 supplementary range, you should either continue to validate the correctness
 of any surrogate characters encountered or provide a clear warning to users
 that your escaper does not validate its input.

 <p>See <A HREF="../../../../../../com/google/template/soy/internal/base/PercentEscaper.html" title="class in com.google.template.soy.internal.base"><CODE>PercentEscaper</CODE></A> for an example.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#nextEscapeIndex(java.lang.CharSequence, int, int)">nextEscapeIndex</A></CODE> in class <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html" title="class in com.google.template.soy.internal.base">UnicodeEscaper</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>csq</CODE> - a sequence of characters<DD><CODE>index</CODE> - the index of the first character to be scanned<DD><CODE>end</CODE> - the index immediately after the last character to be scanned</DL>
</DD>
</DL>
<HR>

<A NAME="escape(java.lang.String)"><!-- --></A><H3>
escape</H3>
<PRE>
public <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>escape</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A>&nbsp;s)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#escape(java.lang.String)">UnicodeEscaper</A></CODE></B></DD>
<DD>Returns the escaped form of a given literal string.

 <p>If you are escaping input in arbitrary successive chunks, then it is not
 generally safe to use this method. If an input string ends with an
 unmatched high surrogate character, then this method will throw
 <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><CODE>IllegalArgumentException</CODE></A>. You should either ensure your input is
 valid <a href="http://en.wikipedia.org/wiki/UTF-16">UTF-16</a> before
 calling this method or use an escaped <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang"><CODE>Appendable</CODE></A> (as returned by
 <A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#escape(java.lang.Appendable)"><CODE>UnicodeEscaper.escape(Appendable)</CODE></A>) which can cope with arbitrarily split input.

 <p><b>Note:</b> When implementing an escaper it is a good idea to override
 this method for efficiency by inlining the implementation of
 <A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#nextEscapeIndex(java.lang.CharSequence, int, int)"><CODE>UnicodeEscaper.nextEscapeIndex(CharSequence, int, int)</CODE></A> directly. Doing this for
 <A HREF="../../../../../../com/google/template/soy/internal/base/PercentEscaper.html" title="class in com.google.template.soy.internal.base"><CODE>PercentEscaper</CODE></A> more than doubled the performance for unescaped
 strings.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html#escape(java.lang.String)">escape</A></CODE> in interface <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/Escaper.html" title="interface in com.google.template.soy.internal.base">Escaper</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#escape(java.lang.String)">escape</A></CODE> in class <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html" title="class in com.google.template.soy.internal.base">UnicodeEscaper</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>s</CODE> - the literal string to be escaped
<DT><B>Returns:</B><DD>the escaped form of <code>string</code></DL>
</DD>
</DL>
<HR>

<A NAME="escape(int)"><!-- --></A><H3>
escape</H3>
<PRE>
protected char[] <B>escape</B>(int&nbsp;cp)</PRE>
<DL>
<DD>Escapes the given Unicode code point in UTF-8.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html#escape(int)">escape</A></CODE> in class <CODE><A HREF="../../../../../../com/google/template/soy/internal/base/UnicodeEscaper.html" title="class in com.google.template.soy.internal.base">UnicodeEscaper</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>cp</CODE> - the Unicode code point to escape if necessary
<DT><B>Returns:</B><DD>the replacement characters, or <code>null</code> if no escaping was
     needed</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../../com/google/template/soy/internal/base/Pair.html" title="class in com.google.template.soy.internal.base"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../../com/google/template/soy/internal/base/UnescapeUtils.html" title="class in com.google.template.soy.internal.base"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../../index.html?com/google/template/soy/internal/base/PercentEscaper.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="PercentEscaper.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

        
          <div id="footer">
            <div id="footerlogo" style="float:left">
              <img src="http://www.google.com/images/art.gif"
                   alt="Google colored balls">
            </div>
            <div id="copyright" style="float:left">
              <p>
                &copy; 2009 Google -
                <a href="http://www.google.com/privacy.html">Privacy Policy</a> -
                <a href="http://www.google.com/terms_of_service.html">Terms and Conditions</a> -
                <a href="http://www.google.com/about.html">About Google</a>
              </p>
            </div>
          </div>
        
      
</BODY>
</HTML>
